Mass Balance - Required Attributes
The Mass Balance Analysis Rule requires that elements have specific Attributes and specific Attribute properties. Input and Output Attributes must be configured to be an allowable value type and have specific units of measure. Input and Output Attributes are listed in these sections:
Elements based on the Sigmafine Element templates are designed to be compatible with this data reference. Custom templates must have Attributes available with units of measure as listed in the following tables. The Attributes that the Sigmafine Element templates are designed to use is also noted in the tables in this section.
Element Attributes that are listed with multiple templates must have common naming across the named templates.
Mass Balance Analysis – Input Attributes
Analysis Configuration - Required Input Attributes
| Configuration Parameter | Attribute Unit | Template Name(s) | Default Attribute Name | Category | Parameter Value Type |
|---|---|---|---|---|---|
| Measured Mass | Mass | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_LiquidMeterTemplateSF_GasMeterTemplateSF_SolidMeterTemplateSF_TransferTemplate | MeasuredMass | SF_AnalysisInput | Double |
| Measured Tolerance | Mass | \<same as above> | MassTolerance | \<same as above> | Double |
| Corrected Measurement | Mass | \<same as above> | CorrectedMass | \<same as above> | Double |
| Corrected Tolerance | Mass | \<same as above> | CorrectedMassTolerance | \<same as above> | Double |
Mass Balance Analysis – Output Attributes
Analysis Configuration - Required Output Attributes
| Configuration Parameter | Attribute Unit | Template Name(s) | Default Attribute Name | Category | Parameter Value Type |
|---|---|---|---|---|---|
| Reconciled Status | \<dimensionless> | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplateSF_LiquidMeterTemplateSF_GasMeterTemplate | InferredStatus | SF_AnalysisOutput | String |
| Test 1 | \<dimensionless> | \<same as above> | ReconciledMassTest1 | \<same as above> | Double |
| Test 2 | \<dimensionless> | \<same as above> | ReconciledMassTest2 | \<same as above> | Double |
| Reconciled Adjustment | Mass | \<same as above> | ReconciledMassCorrection | \<same as above> | Double |
| Reconciled Measurement | Mass | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_FlowTemplateSF_TransferTemplate | ReconciledMass | \<same as above> | Double |
| Solvability | Mass | \<same as above> | ReconciledMassSolvability | \<same as above> | Double |
| Initial Imbalance | Mass | SF_GaugedTankTemplateSF_VolumeTankTemplateSF_NodeTemplateSF_ProcessTemplateSF_ManifoldTemplateSF_HeatExchangerTemplate | ReconciledMassImbalance | \<same as above> | Double |
| Test 3 | \<dimensionless> | \<same as above> | ReconciledMassTest3 | \<same as above> | Double |
| Test 4 | \<dimensionless> | \<same as above> | ReconciledMassTest4 | \<same as above> | Double |
| Reconciled Residual | \<dimensionless> | \<same as above> | ReconciledResidual | \<same as above> | Double |
Note:
You can decrease the size of the Mass Balance Analysis Case stored in the Analysis Framework by removing the categories SF_CaseInputData or SF_CaseResults from that attribute. For example, if you remove an Attribute from the Case results set, it is available only in the session when the analysis steps are run. This is useful for attributes, such as Test values that are not reported, and are primarily used for troubleshooting in the analysis session.
For an Attribute to be saved in the Case input data set, the Attribute must belong to the SF_CaseInputData category. For an Attribute to appear in the input tab of the configuration dialog box, it must belong to the SF_AnalysisInput category.
For an Attribute to be saved in the Case output data set, the Attribute must belong to the SF_CaseResults category. For an Attribute to appear in the output tab of the configuration dialog box, it must belong to the SF_AnalysisOutput category.